Function Reference

_SoundPlay

Play a sound file.

#include <Sound.au3>
_SoundPlay ( $sSnd_id [, $fWait ] )

 

Parameters

$sSnd_id Sound ID (the 'alias') as returned by _SoundOpen or a file
$fWait [optional] This flag determines if the script should wait for the sound to finish before continuing:
1 = wait until sound has finished
0 = continue script while sound is playing (default)

 

Return Value

Success: 1
Failure: 0
@Error: 0 = No Error
1 = Play Failed
2 = $fWait parameter is invalid

 

Remarks

None.

 

Related

_SoundPause, _SoundStop, _SoundSeek

 

Example


#include <Sound.au3>
;open sound file
$sound = _SoundOpen(@WindowsDir & "\media\Windows XP Startup.wav", "Startup")
If @error = 2 Then
    MsgBox(0, "Error", "The file does not exist")
    Exit
ElseIf @error = 3 Then
    MsgBox(0, "Error", "The alias was invalid")
    Exit
ElseIf @extended <> 0 Then
    $extended = @extended ;assign because @extended will be set after DllCall
    $stText = DllStructCreate("char[128]")
    $errorstring = DllCall("winmm.dll","short","mciGetErrorStringA","str",$extended,"ptr",DllStructGetPtr($stText),"int",128)
    MsgBox(0, "Error", "The open failed." & @CRLF & "Error Number: " & $extended & @CRLF & "Error Description: " & DllStructGetData($stText, 1) & @CRLF & "Please Note: The sound may still play correctly.")
Else
    MsgBox(0, "Success", "The file opened successfully")
EndIf
_SoundPlay($sound, 1)

_SoundClose($sound)